Skip to content

feat: Clean cache command#1394

Open
d3xter666 wants to merge 17 commits into
mainfrom
feat-clean-cache
Open

feat: Clean cache command#1394
d3xter666 wants to merge 17 commits into
mainfrom
feat-clean-cache

Conversation

@d3xter666
Copy link
Copy Markdown
Member

The command completely cleans the cache by removing the cache files as well as cleaning up the SQLite records.
It does not wipe out the SQLite DB file(s)

JIRA: CPOUI5FOUNDATION-891

@d3xter666 d3xter666 requested a review from a team May 22, 2026 12:22
@d3xter666 d3xter666 force-pushed the feat-clean-cache branch 2 times, most recently from 83f2262 to d52c4ad Compare May 26, 2026 06:29
@RandomByte RandomByte force-pushed the feat/incremental-build-4 branch from 7c59782 to 444977d Compare May 27, 2026 15:40
Comment thread packages/project/lib/cache/CacheCleanup.js Outdated
Comment thread packages/project/lib/cache/CacheCleanup.js Outdated
Comment thread packages/project/lib/cache/CacheCleanup.js Outdated
Comment thread packages/cli/lib/cli/commands/cache.js
@RandomByte RandomByte force-pushed the feat/incremental-build-4 branch from c2dc7b8 to 1041695 Compare May 29, 2026 08:11
@d3xter666 d3xter666 force-pushed the feat-clean-cache branch 2 times, most recently from dc31834 to f5def12 Compare May 29, 2026 08:29
@RandomByte RandomByte force-pushed the feat/incremental-build-4 branch from 1041695 to 66296d5 Compare May 29, 2026 08:49
@d3xter666 d3xter666 force-pushed the feat-clean-cache branch 2 times, most recently from 77f7320 to aa280da Compare May 29, 2026 10:27
Comment thread packages/project/lib/build/cache/CacheCleanup.js Outdated
@d3xter666 d3xter666 requested a review from matz3 May 29, 2026 13:21
@d3xter666 d3xter666 force-pushed the feat-clean-cache branch 2 times, most recently from 7b17cc0 to 569ff71 Compare May 29, 2026 15:44
@d3xter666 d3xter666 requested a review from a team June 1, 2026 07:46
@d3xter666 d3xter666 changed the base branch from feat/incremental-build-4 to main June 1, 2026 10:10
Comment thread packages/cli/lib/cli/commands/cache.js Outdated
Comment thread packages/cli/lib/cli/commands/cache.js Outdated
Comment thread packages/project/lib/build/cache/CacheManager.js Outdated
@@ -0,0 +1,80 @@
import path from "node:path";
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems odd that this file is placed next to the other files responsible for managing the framework packages but doesn't use any of them. I would expect better integration here, e.g. no hardcoded assumptions like the framework/ directory name as well as checks for existing lockfiles to prevent deleting files while a download is running

Copy link
Copy Markdown
Member Author

@d3xter666 d3xter666 Jun 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand your point, but what botters me is that this might need a bit more of a refactoring.

Here's my rationale.

The AbstractInstaller is an abstract class that implements the lock logic. As the name suggests- it's an installer that is extended by the npm and maven installers.
Cache clanup, except from having in common the locks and paths, is a completelly different topic- it needs to clean the framework files. I have also seen that the framework folder is not configured in the AbstractInstaller, but is hardcoded in every installer.

The only clean option I forsee is to consolidate and reuse the locking logic and abstract the "framework" dir within the AbstractInstaller. Then somehow reuse this information in the cache cleaner.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have refactored the code, so that framework folder is reused accross classes and the locking is respecte.
Hopefully, this change addresses you comment: 8a53eb8

Let me know if you have other concerns on that matter

Comment thread packages/project/lib/ui5Framework/cache.js Outdated
Comment thread packages/project/lib/ui5Framework/cache.js Outdated
* @param {string} dirPath Absolute path to directory
* @returns {Promise<number>} Total size in bytes
*/
async function getDirectorySize(dirPath) {
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On my system this results in a different number than du:

~/.ui5
❯ du -sh framework 
 37G	framework
❯ ui5 cache clean

The following items from cache will be removed:
  • framework/ (31.9 GB)
  • buildCache/v0_7 (70.7 MB)

Total: 32.0 GB

In my case, it also takes over a minute to calculate the size, which makes me wonder whether we should really do that or rather list the number of artifacts. Something like "this will delete 500 packages across 40 versions of UI5" would be much faster to calculate - not sure yet.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm, that's fair!
Thanks for that feedback! I have not tested with that hughe amount of data!
I suppose the data difference comes from the way we calculate the conversion from bytes -> mb -> gb -> etc.
We do it by dividing to 1024 while in some systems they use 1000. I'm not sure whetehr this is the case here.
Maybe, if we check the bytes we can say whether it's the calculation base, or something within the node's fs.stats and du.

export async function cleanCache(ui5DataDir) {
const frameworkDir = path.join(ui5DataDir, "framework");
try {
const size = await getDirectorySize(frameworkDir);
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since it takes a long time to calculate the size of a large cache, could we skip calculating it again during the cleaning?

Comment thread packages/project/lib/build/cache/CacheManager.js
@matz3
Copy link
Copy Markdown
Member

matz3 commented Jun 2, 2026

I think the usability of the command could be improved.

  • No information about the actual filesystem paths of the cache and relevant dirs (not in CLI description, not in --help, not in command output
  • No information about the relation to ui5DataDir config / UI5_DATA_DIR env var
  • No output when command is executed, and it might take a while to calculate the size, so users might assume the command is stuck if it does not print anything for a minute or longer.
  • Output lists two different sizes 197.0 MB vs 196.8 MB:
The following items from cache will be removed:
  • buildCache/v0_7 (197.0 MB)

Total: 197.0 MB


✓ Removed buildCache/v0_7 (196.8 MB)

Success: Cleaned 1 entry, freed 196.8 MB
  • (minor) Inconsistency in logged paths (framework/ vs framework):
The following items from cache will be removed:
  • framework/ (711.4 MB)

Total: 711.4 MB

Do you want to continue? (y/N) y

✓ Removed framework (711.4 MB)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants